<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>digichef.tagging.models.TaggedItemManager</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="digichef-module.html">Package&nbsp;digichef</a> ::
        <a href="digichef.tagging-module.html">Package&nbsp;tagging</a> ::
        <a href="digichef.tagging.models-module.html">Module&nbsp;models</a> ::
        Class&nbsp;TaggedItemManager
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="digichef.tagging.models.TaggedItemManager-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class TaggedItemManager</h1><p class="nomargin-top"><span class="codelink"><a href="digichef.tagging.models-pysrc.html#TaggedItemManager">source&nbsp;code</a></span></p>
<center>
<center>  <map id="uml_class_diagram_for_digichef_51" name="uml_class_diagram_for_digichef_51">
<area shape="rect" href="digichef.tagging.models.TaggedItemManager-class.html#get_by_model" title="Create a ``QuerySet`` containing instances of the specified model associated with a given tag or list of tags." alt="" coords="17,36,359,55"/>
<area shape="rect" href="digichef.tagging.models.TaggedItemManager-class.html#get_intersection_by_model" title="Create a ``QuerySet`` containing instances of the specified model associated with *all* of the given list of tags." alt="" coords="17,55,359,73"/>
<area shape="rect" href="digichef.tagging.models.TaggedItemManager-class.html#get_union_by_model" title="Create a ``QuerySet`` containing instances of the specified model associated with *any* of the given list of tags." alt="" coords="17,73,359,92"/>
<area shape="rect" href="digichef.tagging.models.TaggedItemManager-class.html#get_related" title="Retrieve a list of instances of the specified model which share tags with the model instance ``obj``, ordered by the number of shared tags in descending order." alt="" coords="17,92,359,111"/>
<area shape="rect" href="digichef.tagging.models.TaggedItemManager-class.html" title="FIXME There&#39;s currently no way to get the ``GROUP BY`` and ``HAVING`` SQL clauses required by many of this manager&#39;s methods into Django&#39;s ORM." alt="" coords="16,11,360,112"/>
</map>
  <img src="uml_class_diagram_for_digichef_51.gif" alt='' usemap="#uml_class_diagram_for_digichef_51" ismap="ismap" class="graph-without-title" />
</center>
</center>
<hr />
<pre class="literalblock">

FIXME There's currently no way to get the ``GROUP BY`` and ``HAVING``
      SQL clauses required by many of this manager's methods into
      Django's ORM.

      For now, we manually execute a query to retrieve the PKs of
      objects we're interested in, then use the ORM's ``__in``
      lookup to return a ``QuerySet``.

      Now that the queryset-refactor branch is in the trunk, this can be
      tidied up significantly.

</pre>

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="get_by_model"></a><span class="summary-sig-name">get_by_model</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">queryset_or_model</span>,
        <span class="summary-sig-arg">tags</span>)</span><br />
      Create a ``QuerySet`` containing instances of the specified
model associated with a given tag or list of tags.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="digichef.tagging.models-pysrc.html#TaggedItemManager.get_by_model">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="get_intersection_by_model"></a><span class="summary-sig-name">get_intersection_by_model</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">queryset_or_model</span>,
        <span class="summary-sig-arg">tags</span>)</span><br />
      Create a ``QuerySet`` containing instances of the specified
model associated with *all* of the given list of tags.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="digichef.tagging.models-pysrc.html#TaggedItemManager.get_intersection_by_model">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="get_union_by_model"></a><span class="summary-sig-name">get_union_by_model</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">queryset_or_model</span>,
        <span class="summary-sig-arg">tags</span>)</span><br />
      Create a ``QuerySet`` containing instances of the specified
model associated with *any* of the given list of tags.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="digichef.tagging.models-pysrc.html#TaggedItemManager.get_union_by_model">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="digichef.tagging.models.TaggedItemManager-class.html#get_related" class="summary-sig-name">get_related</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">obj</span>,
        <span class="summary-sig-arg">queryset_or_model</span>,
        <span class="summary-sig-arg">num</span>=<span class="summary-sig-default">None</span>)</span><br />
      Retrieve a list of instances of the specified model which share
tags with the model instance ``obj``, ordered by the number of
shared tags in descending order.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="digichef.tagging.models-pysrc.html#TaggedItemManager.get_related">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="get_related"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_related</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">obj</span>,
        <span class="sig-arg">queryset_or_model</span>,
        <span class="sig-arg">num</span>=<span class="sig-default">None</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="digichef.tagging.models-pysrc.html#TaggedItemManager.get_related">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">

Retrieve a list of instances of the specified model which share
tags with the model instance ``obj``, ordered by the number of
shared tags in descending order.

If ``num`` is given, a maximum of ``num`` instances will be
returned.

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Thu Apr  1 02:28:27 2010
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
